Audio Interrupt Transition Params JSON Reference
| Declared in | Voiceflow.schema.json |
Overview
Specifies the parameters for transitioning Voiceflow processing to a Voiceflow Module after Audio Session interruption ends. "audioInterruptTransitionParams" configuration is used in all Voiceflow Modules but more relevant when used in Voiceflow Modules that perform audio playback: "playAudio", "recordAudio", "audioDialog" and "audioListener". "audioInterruptTransitionParams" configured in "process" type Voiceflow Module will set the default audio interruption transition for the Voiceflow. "audioInterruptTransitionParams" configured in other type Voiceflow Modules will set the audio interruption transition for those specifc Voiceflow Modules and will override the default one set for the Voiceflow.
Note: Unless stated otherwise, value of properties that are of type "string" can be updated at runtime by an application if their value is entered as a field name wrapped by "$[" and "]". If a property is of a type other than "string", then an additional property of type "string" with the same property name appended with the string "Runtime" is added to have its value entered as a field name wrapped by "$[" and "]". This allows the application to set the value of the field name at runtime to be the value of the original non-runtime property. Valid values of runtime fields override the values of non-runtime properties.
Tasks
-
transitionTypepropertyThe transition type. Values:
"resume","repeat","goto", or"end". Default:"end"if no default is set for Voiceflow. The value can be set at runtime using"$[<FieldName>]"entry convention.Parameter is optional.
-
goToVoiceFlowModuleIDpropertyThe ID of a Voiceflow Module ID in current Voiceflow to transition to. Use with
"goto"transition type. Default:"VF_END"if no default is set for Voiceflow. The value can be set at runtime using"$[<FieldName>]"entry convention.Parameter is optional.
-
rewindCurrentAudioSegmentMspropertyValue is number of Milliseconds to rewind the audio segment playback from the time position it was interrupted at. Use with
"resume"transition type. Default: 0 if no default is set for Voiceflow. The value can be set at runtime using the"rewindCurrentAudioSegmentMsRuntime"property.Parameter is optional.
-
rewindCurrentAudioSegmentMsRuntimepropertyContains the name of a field, as a string wrapped between
"$["and"]", whose integer value can be set at runtime by an application. If the value of the field is a valid integer, then it will replace the value entered in the"rewindCurrentAudioSegmentMs"property. Example:"$[RewindCurrentAudioSegmentMs]".Parameter is optional.
-
restartCurrentAudioSegmentpropertySpecifies whether to play current audio segment that was interrupted from the beginning. Default:
"false"if no default is set for Voiceflow. The value can be set at runtime using the"restartCurrentAudioSegmentRuntime"property.Parameter is optional.
-
restartCurrentAudioSegmentRuntimepropertyContains the name of a field, as a string wrapped between
"$["and"]", whose boolean value can be set at runtime by an application. If the value of the field is a valid boolean, then it will replace the value entered in the"restartCurrentAudioSegment"property. Example:"$[RestartCurrentAudioSegment]".Parameter is optional.
Properties
goToVoiceFlowModuleID
"goToVoiceFlowModuleID": string
Discussion
The ID of a Voiceflow Module ID in current Voiceflow to transition to. Use with "goto" transition type. Default: "VF_END" if no default is set for Voiceflow. The value can be set at runtime using "$[<FieldName>]" entry convention.
Parameter is optional.
Declared In
Voiceflow.schema.json
restartCurrentAudioSegment
"restartCurrentAudioSegment": boolean
Discussion
Specifies whether to play current audio segment that was interrupted from the beginning. Default: "false" if no default is set for Voiceflow. The value can be set at runtime using the "restartCurrentAudioSegmentRuntime" property.
Parameter is optional.
Declared In
Voiceflow.schema.json
restartCurrentAudioSegmentRuntime
"restartCurrentAudioSegmentRuntime": string
Discussion
Contains the name of a field, as a string wrapped between "$[" and "]", whose boolean value can be set at runtime by an application. If the value of the field is a valid boolean, then it will replace the value entered in the "restartCurrentAudioSegment" property. Example: "$[RestartCurrentAudioSegment]".
Parameter is optional.
Declared In
Voiceflow.schema.json
rewindCurrentAudioSegmentMs
"rewindCurrentAudioSegmentMs": integer
Discussion
Value is number of Milliseconds to rewind the audio segment playback from the time position it was interrupted at. Use with "resume" transition type. Default: 0 if no default is set for Voiceflow. The value can be set at runtime using the "rewindCurrentAudioSegmentMsRuntime" property.
Parameter is optional.
Declared In
Voiceflow.schema.json
rewindCurrentAudioSegmentMsRuntime
"rewindCurrentAudioSegmentMsRuntime": string
Discussion
Contains the name of a field, as a string wrapped between "$[" and "]", whose integer value can be set at runtime by an application. If the value of the field is a valid integer, then it will replace the value entered in the "rewindCurrentAudioSegmentMs" property. Example: "$[RewindCurrentAudioSegmentMs]".
Parameter is optional.
Declared In
Voiceflow.schema.json